Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: 完善 2.0 版本文档 #2492

Merged
merged 72 commits into from
Feb 5, 2024
Merged

docs: 完善 2.0 版本文档 #2492

merged 72 commits into from
Feb 5, 2024

Conversation

lijinke666
Copy link
Member

@lijinke666 lijinke666 commented Dec 26, 2023 •
edited
Loading

👀 PR includes

🔧 Chore

  • Test case
  • Docs / demos update
  • CI / workflow
  • Release version
  • Other ()

📝 Description

TODO:

  • 教程

    • 所有文档走查, 润色修改
    • mini 图 & G2 图表
    • 自定义行列头单元格
    • 多行文本
    • 行列字段标记
    • headerActionIcons 增强 (position)
    • 暗黑主题
    • 完善 (README & 快速上手 & 简介)
    • 单元格宽高增强
    • React 组件的使用方式替换成 React 18
    • API 校对
    • 增加版本选择 (1.x, 2.x)
    • 异步渲染说明
    • 文档目录梳理调整
    • 数据格式化
    • 获取单元格数据 (dataset/获取单元格/获取数据/汇总数据)
    • 性能数据更新
    • 自定义行头最大固定宽度的功能 文档说明

  • 示例

    • 确保所有 demo 可运行
    • React 组件的使用方式替换成 React 18
    • API 校对
    • 自定义单元格/边框/图层: G 4.0 的语法替换成 G 5.0

🖼️ Screenshot

Before After
❌ ✅

🔗 Related issue link

🔍 Self-Check before the merge

  • Add or update relevant docs.
  • Add or update relevant demos.
  • Add or update test case.
  • Add or update relevant TypeScript definitions.

@vercel Vercel
Copy link

vercel bot commented Dec 26, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
antvis-s2 ❌ Failed (Inspect) Feb 5, 2024 3:54am

@github-actions github-actions bot added the next 2.0-next 版本的问题 label Dec 26, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 26, 2023 •
edited
Loading

Size Change: +34 B (0%)

Total Size: 311 kB

Filename Size Change
./packages/s2-core/dist/index.min.js 217 kB +34 B (0%)
ℹ️ View Unchanged
Filename Size
./packages/s2-core/dist/style.min.css 402 B
./packages/s2-react/dist/index.min.js 67.6 kB
./packages/s2-react/dist/style.min.css 3.99 kB
./packages/s2-vue/dist/index.min.js 20.2 kB
./packages/s2-vue/dist/style.min.css 1.98 kB

compressed-size-action

@codecov Codecov
Copy link

codecov bot commented Dec 26, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ecdc9c8) 75.77% compared to head (32636af) 78.39%.
Report is 231 commits behind head on next.

❗ Current head 32636af differs from pull request most recent head bacebc3. Consider uploading reports for the commit bacebc3 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             next    #2492      +/-   ##
==========================================
+ Coverage   75.77%   78.39%   +2.62%     
==========================================
  Files         257      275      +18     
  Lines       11994    12487     +493     
  Branches     2464     2556      +92     
==========================================
+ Hits         9088     9789     +701     
+ Misses       1398     1140     -258     
- Partials     1508     1558      +50

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 26, 2023 •
edited
Loading

你好, @lijinke666 CI 执行失败, 请点击 [Details] 按钮查看, 并根据日志修复。

Hello, @lijinke666 CI run failed, please click the [Details] button for detailed log information and fix it.

@github-actions github-actions bot added the 🚨 test failed 单元测试挂了 label Dec 26, 2023
@github-actions github-actions bot removed the 🚨 test failed 单元测试挂了 label Dec 26, 2023
@github-actions github-actions bot added the 🚨 test failed 单元测试挂了 label Dec 26, 2023
@github-actions github-actions bot removed the 🚨 test failed 单元测试挂了 label Dec 27, 2023
@lijinke666 lijinke666 changed the title [WIP] docs: 完善 2.0 版本文档 docs: 完善 2.0 版本文档 Feb 5, 2024
@github-actions github-actions bot added the pr(documentation) documentation label Feb 5, 2024
@github-actions github-actions bot removed the 🚨 lint failed 静态检查失败 label Feb 5, 2024
@lijinke666 lijinke666 merged commit 2df2032 into next Feb 5, 2024
5 of 8 checks passed
@lijinke666 lijinke666 deleted the docs-2.0 branch February 5, 2024 03:48
@github-actions github-actions bot added 🚨 test failed 单元测试挂了 and removed 🚨 test failed 单元测试挂了 labels Feb 5, 2024
@lijinke666
Copy link
Member Author

🎉 This PR is included in version @antv/s2-v2.0.0-next.11 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lijinke666
Copy link
Member Author

🎉 This PR is included in version @antv/s2-react-v2.0.0-next.10 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lijinke666
Copy link
Member Author

🎉 This PR is included in version @antv/s2-vue-v2.0.0-next.10 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GaoFuhong GaoFuhong Awaiting requested review from GaoFuhong

@lcx-seima lcx-seima Awaiting requested review from lcx-seima

@serializedowen serializedowen Awaiting requested review from serializedowen

@stone-lyl stone-lyl Awaiting requested review from stone-lyl

@wjgogogo wjgogogo Awaiting requested review from wjgogogo

Assignees

@lijinke666 lijinke666

Labels
next 2.0-next 版本的问题 pr(documentation) documentation released on @next 🚨 test failed 单元测试挂了
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lijinke666 @wjgogogo